<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArS3SeriesPacketReceiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArS3SeriesPacketReceiver.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classArS3SeriesPacketReceiver-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArS3SeriesPacketReceiver Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Given a device connection it receives packets from the sick through it.  
 <a href="classArS3SeriesPacketReceiver.html#details">More...</a></p>

<p><code>#include &lt;ArS3Series.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4552e80d27e72ae102dbb5bb28bddfea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4552e80d27e72ae102dbb5bb28bddfea"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArS3SeriesPacketReceiver.html#a4552e80d27e72ae102dbb5bb28bddfea">ArS3SeriesPacketReceiver</a> ()</td></tr>
<tr class="memdesc:a4552e80d27e72ae102dbb5bb28bddfea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with assignment of a device connection. <br /></td></tr>
<tr class="separator:a4552e80d27e72ae102dbb5bb28bddfea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7222aa3b52bd944c6d877ecb44d6ccfa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7222aa3b52bd944c6d877ecb44d6ccfa"></a>
unsigned short&#160;</td><td class="memItemRight" valign="bottom"><b>CRC16</b> (unsigned char *, int)</td></tr>
<tr class="separator:a7222aa3b52bd944c6d877ecb44d6ccfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a772f930a70a65e9a30e6190232080a6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a772f930a70a65e9a30e6190232080a6b"></a>
<a class="el" href="classArDeviceConnection.html">ArDeviceConnection</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArS3SeriesPacketReceiver.html#a772f930a70a65e9a30e6190232080a6b">getDeviceConnection</a> (void)</td></tr>
<tr class="memdesc:a772f930a70a65e9a30e6190232080a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the device this instance receives packets from. <br /></td></tr>
<tr class="separator:a772f930a70a65e9a30e6190232080a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a097fc63c8531a718b9a918e5a45d6bb7"><td class="memItemLeft" align="right" valign="top">ArS3SeriesPacket *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArS3SeriesPacketReceiver.html#a097fc63c8531a718b9a918e5a45d6bb7">receivePacket</a> (unsigned int msWait=0, bool shortcut=false)</td></tr>
<tr class="memdesc:a097fc63c8531a718b9a918e5a45d6bb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a packet from the robot if there is one available.  <a href="#a097fc63c8531a718b9a918e5a45d6bb7">More...</a><br /></td></tr>
<tr class="separator:a097fc63c8531a718b9a918e5a45d6bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad60604e1f51c439bb98ec665c775db9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad60604e1f51c439bb98ec665c775db9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArS3SeriesPacketReceiver.html#aad60604e1f51c439bb98ec665c775db9">setDeviceConnection</a> (<a class="el" href="classArDeviceConnection.html">ArDeviceConnection</a> *conn)</td></tr>
<tr class="memdesc:aad60604e1f51c439bb98ec665c775db9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the device this instance receives packets from. <br /></td></tr>
<tr class="separator:aad60604e1f51c439bb98ec665c775db9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae3b1ec3f42e13a900cfb9ceab687106"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae3b1ec3f42e13a900cfb9ceab687106"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setInfoLogLevel</b> (<a class="el" href="classArLog.html#ac8cc0fb3aa323ab2a1c21340fdd1dce3">ArLog::LogLevel</a> infoLogLevel)</td></tr>
<tr class="separator:aae3b1ec3f42e13a900cfb9ceab687106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4edd1d847707543ee06c7774afa5679"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4edd1d847707543ee06c7774afa5679"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setIsS300</b> (bool isS300)</td></tr>
<tr class="separator:aa4edd1d847707543ee06c7774afa5679"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2758d7ab6c629a076dbd0966ca8b1432"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2758d7ab6c629a076dbd0966ca8b1432"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setName</b> (const char *name)</td></tr>
<tr class="separator:a2758d7ab6c629a076dbd0966ca8b1432"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebbc437f5f35741df6008d33615a75b6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebbc437f5f35741df6008d33615a75b6"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArS3SeriesPacketReceiver.html#aebbc437f5f35741df6008d33615a75b6">~ArS3SeriesPacketReceiver</a> ()</td></tr>
<tr class="memdesc:aebbc437f5f35741df6008d33615a75b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:aebbc437f5f35741df6008d33615a75b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a577b7e670447f30afaa371cd68816a53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a577b7e670447f30afaa371cd68816a53"></a>
<a class="el" href="classArDeviceConnection.html">ArDeviceConnection</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>myConn</b></td></tr>
<tr class="separator:a577b7e670447f30afaa371cd68816a53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bb2d15e47e0a3415f8f1c24c88acef3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bb2d15e47e0a3415f8f1c24c88acef3"></a>
<a class="el" href="classArLog.html#ac8cc0fb3aa323ab2a1c21340fdd1dce3">ArLog::LogLevel</a>&#160;</td><td class="memItemRight" valign="bottom"><b>myInfoLogLevel</b></td></tr>
<tr class="separator:a9bb2d15e47e0a3415f8f1c24c88acef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac756904f548752045feaf858a297b8fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac756904f548752045feaf858a297b8fd"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myIsS300</b></td></tr>
<tr class="separator:ac756904f548752045feaf858a297b8fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28ec0f6af3f084f946ce8b58d7a461f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28ec0f6af3f084f946ce8b58d7a461f0"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>myName</b> [1024]</td></tr>
<tr class="separator:a28ec0f6af3f084f946ce8b58d7a461f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63e23ec82282c6a811aba44c340ee905"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63e23ec82282c6a811aba44c340ee905"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>myNameLength</b></td></tr>
<tr class="separator:a63e23ec82282c6a811aba44c340ee905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b10c4d70efbf249c7f7b0b45e17ad0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b10c4d70efbf249c7f7b0b45e17ad0b"></a>
ArS3SeriesPacket&#160;</td><td class="memItemRight" valign="bottom"><b>myPacket</b></td></tr>
<tr class="separator:a9b10c4d70efbf249c7f7b0b45e17ad0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab64b56061691fca95170109e270b4532"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab64b56061691fca95170109e270b4532"></a>
unsigned char&#160;</td><td class="memItemRight" valign="bottom"><b>myReadBuf</b> [100000]</td></tr>
<tr class="separator:ab64b56061691fca95170109e270b4532"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2ba0dd77013eae575615433e430873d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2ba0dd77013eae575615433e430873d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>myReadCount</b></td></tr>
<tr class="separator:ad2ba0dd77013eae575615433e430873d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Given a device connection it receives packets from the sick through it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a097fc63c8531a718b9a918e5a45d6bb7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ArS3SeriesPacket * ArS3SeriesPacketReceiver::receivePacket </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>msWait</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>shortcut</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receives a packet from the robot if there is one available. </p>
<p>MPL this timeout was 5000, but I've made it 200 since the number of readings could be bogus and we don't want to go 5 seconds with no readings </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ArS3Series.h</li>
<li>ArS3Series.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArS3SeriesPacketReceiver.html">ArS3SeriesPacketReceiver</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
